/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.flowable.common.engine.api.tenant;

/**
 * Helper for changing the tenant id from active and historic instances.
 * <p>
 * An instance can be created with the corresponding management service of each of the BPMN, CMMN or DMN scopes.
 *
 * @author Jorge Mora Giménez
 * @author Filip Hrisafov
 */
public interface ChangeTenantIdBuilder {

    /**
     * Perform the change only for instances that were created using a definition from the given tenant.
     */
    ChangeTenantIdBuilder definitionTenantId(String definitionTenantId);

    /**
     * Executes a simulation of the change of tenant id, calculating the number of instances that will be affected
     *
     * @return {@link ChangeTenantIdResult}
     */
    ChangeTenantIdResult simulate();

    /**
     * Executes change in the tenant id, returning the number of instances that were affected
     *
     * @return {@link ChangeTenantIdResult}
     */
    ChangeTenantIdResult complete();

}
